/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2002 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "Ant" and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */
package com.phenix.pct;

import java.io.File;

/**
 * Describes an OUTPUT parameter which will be passed to a progress procedure. Value is written in a
 * property
 * 
 * @author <a href="mailto:justus_phenix@users.sourceforge.net">Gilles QUERRET </a>
 * @version $Revision: 786 $
 * @since 0.14
 */
public class OutputParameter {
    private String propertyName = null;
    private File tempFile = null;
    private String progressVar = null;

    /**
     * Default constructor
     */
    public OutputParameter() {
    }

    /**
     * Parameter name
     * 
     * @param name String
     */
    public void setName(String name) {
        this.propertyName = name;
    }

    /**
     * Returns parameter name
     * 
     * @return Parameter name
     */
    public String getName() {
        return this.propertyName;
    }

    /**
     * Temporary file where output parameter will be written. ANT reads this file to fill the
     * property
     * 
     * @param file
     */
    protected void setTempFileName(File file) {
        this.tempFile = file;
    }

    protected File getTempFileName() {
        return this.tempFile;
    }

    /**
     * Variable name in pctinit procedure
     * 
     * @param progressVar
     */
    protected void setProgressVar(String progressVar) {
        this.progressVar = progressVar;
    }

    protected String getProgressVar() {
        return this.progressVar;
    }

    /**
     * An OutputParameter equals another one if propertyName are equals
     */
    public boolean equals(Object obj) {
        if (!(obj instanceof OutputParameter))
            return false;
        if (propertyName == null)
            return false;

        return propertyName.equals(((OutputParameter) obj).getName());
    }

    /**
     * PropertyName hashCode
     */
    public int hashCode() {
        return propertyName.hashCode();
    }
}
